Skip to content

use numbered prefix for first folder - #125

Merged
nmschulte merged 19 commits into
FOME-Tech:masterfrom
mi-hol:sidebar_order
Aug 21, 2023
Merged

nmschulte merged 19 commits into
FOME-Tech:masterfrom
mi-hol:sidebar_order

Conversation

@mi-hol

@mi-hol mi-hol commented Jul 7, 2023

Copy link
Copy Markdown
Contributor

No description provided.

@mi-hol
mi-hol marked this pull request as draft July 7, 2023 22:06
Comment thread docs/01-Welcome-to-FOME.md Resolved
Comment thread docs/01-Welcome-to-FOME.md Resolved
Comment thread docs/01-Welcome-to-FOME.md Resolved
Comment thread docs/01-Welcome-to-FOME.md Resolved
@mi-hol

mi-hol commented Jul 8, 2023

Copy link
Copy Markdown
Contributor Author

@karniv00l after I added the comment I get errors. Is there maybe a different format for comments required for docusaurus?
Error:

8
[INFO] [en] Creating an optimized production build...
Error: Error while parsing Markdown front matter.
This can happen if you use special characters in front matter values (try using double quotes around that value).
Error: Loading of version failed for version current
Error: Unable to build website for locale en.
Error: Error: Can't process doc metadata for doc at path path=/home/runner/work/wiki/wiki/docs/01-Welcome-to-FOME.md in version name=current
at processDocMetadata (/home/runner/work/wiki/wiki/node_modules/@docusaurus/plugin-content-docs/lib/docs.js:200:15)
at async Promise.all (index 0)
[INFO] Docusaurus version: 2.4.1
Node version: v18.16.1
Error: Process completed with exit code 1.

@mi-hol

mi-hol commented Jul 8, 2023

Copy link
Copy Markdown
Contributor Author

@karniv00l after I added the comment I get errors. Is there maybe a different format for comments required for docusaurus?

Error resolved!
Comments seem not allowed inside "processing instructions" for docusaurus

@mi-hol
mi-hol marked this pull request as ready for review July 8, 2023 14:57
@mi-hol mi-hol changed the title use numbered prefix use numbered prefix for first folder Jul 8, 2023
@mi-hol

mi-hol commented Jul 8, 2023

Copy link
Copy Markdown
Contributor Author

ready for review, more PRs are planned to be provided

@mi-hol
mi-hol requested a review from OrchardPerformance July 8, 2023 15:17
@mi-hol

mi-hol commented Jul 24, 2023

Copy link
Copy Markdown
Contributor Author

with #124 merged, to get 4 successful checks could someone please re-run the failed "Lint / markdown (pull_request)" ?

@karniv00l

Copy link
Copy Markdown
Member

@mi-hol you can just merge/rebase on master or click "Update branch"

@mi-hol

mi-hol commented Jul 24, 2023

Copy link
Copy Markdown
Contributor Author

click "Update branch"

Thanks @karniv00l that was the easiest solution :)

@nmschulte

Copy link
Copy Markdown
Contributor

Addresses #102.

@nmschulte nmschulte left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did a quick review; wondering if some changes are intended or not w/re: specific ordering.

Comment thread docs/02-Quick-intro.md Resolved
Comment thread docs/02-Quick-intro.md Resolved
Comment thread docs/01-Welcome-to-FOME.md Resolved
@mi-hol
mi-hol requested a review from nmschulte August 21, 2023 01:23
@nmschulte

Copy link
Copy Markdown
Contributor

This is what I see running Docusaurus:
image

There are 12 items in the top-level listing, however, "Intro - Start Here" is prefixed as 03 when it's the 2nd in the list, and "Quick page to show how to make one in the wiki" is prefixed as 13 when it's 11th in the list. Did you intend for "Quick page to show how to make one in the wiki" to be at the very bottom (12th)?

@mi-hol

mi-hol commented Aug 21, 2023

Copy link
Copy Markdown
Contributor Author

There are 12 items in the top-level listing, however, "Intro - Start Here" is prefixed as 03 when it's the 2nd in the list, and "Quick page to show how to make one in the wiki" is prefixed as 13 when it's 11th in the list

Thanks for reviewing.
Please keep in mind this PR is only the first patch not the final result.
I plan to provide one PR per folder, but I'll hold back putting in effort until I see a first result.

Therefore the prefix numbers are not final and the position assignment will not work in all cases unless all embedded "position" directives are removed in later stages.
What you currently see is the first desired state.

Is that ok to merge?

@nmschulte

Copy link
Copy Markdown
Contributor

What you currently see is the first desired state.

Is that ok to merge?

I'm happy with this. I'll merge it

@nmschulte
nmschulte merged commit d1ed5f9 into FOME-Tech:master Aug 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants